Skip to content

Hotfix - shell injection vulnerability#1354

Merged
DavidsonGomes merged 3 commits intoEvolutionAPI:developfrom
jeffersonfelixdev:hotfix/issue-1348
Apr 8, 2025
Merged

Hotfix - shell injection vulnerability#1354
DavidsonGomes merged 3 commits intoEvolutionAPI:developfrom
jeffersonfelixdev:hotfix/issue-1348

Conversation

@jeffersonfelixdev
Copy link
Contributor

@jeffersonfelixdev jeffersonfelixdev commented Apr 2, 2025 •
edited by sourcery-ai bot
Loading

This Pull request change execSync to execFileSync, to avoid shell injection vulnerability.

@DavidsonGomes please priorize this hotfix to production

This closes #1348

Summary by Sourcery

Implement security fix to prevent shell injection vulnerability by replacing execSync with execFileSync

Bug Fixes:

  • Replace potentially dangerous execSync calls with execFileSync to mitigate shell injection risks in multiple files

Chores:

  • Update CHANGELOG.md to document the security hotfix

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Apr 2, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request addresses a shell injection vulnerability by replacing execSync with execFileSync in src/api/provider/sessions.ts and src/api/services/monitor.service.ts. A changelog entry was also added to document the hotfix.

Sequence diagram for killing the process

sequenceDiagram
  participant P as Process
  P->>P: Calls execFileSync('kill', ['-9', `${pid}`])
  P->>OS: Sends kill signal to process with PID
  OS-->>P: Process is terminated
Loading

Sequence diagram for cleaning store data

sequenceDiagram
  participant W as WAMonitoringService
  W->>W: Calls execFileSync('rm', ['-rf', instancePath])
  W->>OS: Sends command to remove directory recursively
  OS-->>W: Directory is removed
Loading

File-Level Changes

Change Details Files
Replaced execSync with execFileSync to mitigate a shell injection vulnerability.
  • Replaced execSync with execFileSync in ProviderFiles to kill the process.
  • Replaced execSync with execFileSync in WAMonitoringService to remove store data.
 src/api/provider/sessions.ts
src/api/services/monitor.service.ts
Added a changelog entry for the hotfix.
  • Added a new version entry for the hotfix.
  • Added a 'Fixed' section to the changelog.
  • Added a note about the shell injection vulnerability fix.
 CHANGELOG.md

Assessment against linked issues

Issue Objective Addressed Explanation
#1348 Prevent shell injection vulnerability when creating/deleting instances. ✅
#1348 Prevent shell injection vulnerability when cleaning store data. ✅

Possibly linked issues

  • #1348: The PR fixes the shell injection vulnerability by changing execSync to execFileSync, preventing command injection.
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Apr 2, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @jeffersonfelixdev - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Thanks for fixing this vulnerability, using execFileSync is definitely the right approach.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@DavidsonGomes DavidsonGomes changed the base branch from main to develop April 8, 2025 13:50
@DavidsonGomes DavidsonGomes merged commit 7c7dca9 into EvolutionAPI:develop Apr 8, 2025
1 check passed
andre-xizto
andre-xizto reviewed Apr 15, 2025
View reviewed changes
Copy link

@andre-xizto andre-xizto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks fine!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

+1 more reviewer

@andre-xizto andre-xizto andre-xizto left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jeffersonfelixdev @andre-xizto @DavidsonGomes